home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / bbsutils / xrs5lang.arj / HELPLIB.HLP (.txt) < prev    next >
Help Librarian Help File  |  1993-08-24  |  17KB  |  201 lines

  1. C-Worthy (R) Help Librarian Data File Version 1.0
  2. COPYRIGHT (C) 1985 - 1989.  All Rights Reserved.
  3. Custom Design Systems, Inc.  Orem, Utah  USA.
  4.                   AVAILABLE OPTIONS HELP
  5.      This menu shows the available options.  To select an option, possition the highlight on the desired option and press <Enter>.  If you are finished using the message librarian, press <Esc>.  To get a list of the specific key assignments on your machine, press the help key a second time.
  6.      See the next page of help for a brief description of each option using <PgDn> to advance to the next page.
  7.                                               Page 1 of 3h
  8.                  AVAILABLE OPTIONS HELP
  9. CREATE HELP CONTEXT NAME FILE
  10.      Will allow you to create a file of help screens containing only the help
  11.      context.  See the next help screen for a more detailed description.
  12. CREATE NEW HELP LIBRARY
  13.      Will allow you to create a new help library file from scratch.
  14. EDIT EXISTING HELP LIBRARY
  15.      Will allow you to specify the filename of a help library file which
  16.      already exists.  You can then edit that file.
  17. PRINT HELP SCREENS
  18.      Will allow you to print all the help screens from an existing message
  19.      library to a file that you specify.
  20.                                                                   Page 2 of 3
  21.           AVAILABLE OPTIONS HELP
  22. CREATE HELP CONTEXT NAME FILE
  23.      To use this option, a help library must already exist.
  24.      This option is useful when you created a help file that contains only
  25.      help context names  (i.e. there are no help screens in the help
  26.      library).  This option will read in the the help library, and write out
  27.      a .CXT file containing help screens with the context name as the help
  28.      screen.  This file can then be renamed to a .HLP file and used as the
  29.      help file for the program.
  30.      The border of these help screens will be blinking to distinguish them
  31.      from help screens created in the normal way.  When you are ready to
  32.      create the actual help screens, go into the Help Librarian, create a new
  33.      help screen, and delete the blinking one.
  34.                                                                   Page 3 of 3
  35.           EXIT HELP LIBRARIAN HELP
  36.      If you are finished using the Help Librarian then answer YES, otherwise answer NO or press <Esc>.
  37.      No changes will be lost by exiting at this point.
  38.                                Page 1 of 1
  39.                       LIBRARY NAME HELP
  40.      Enter the name of the help library file to be edited and press <Enter>.  If the help library file is not in the current directory, the path to reach the help library file should also be specified.  No file extension is needed on the name, if an extension is entered it will be ignored.
  41.      Press <Ins> for a list of existing help library files in the current directory.
  42.                                                   Page 1 of 1
  43.           EXISTING LIBRARIES HELP
  44.      Select the help library you want to edit by positioning the highlight on the help library name and pressing <Enter>.  If you do not want to edit a help library from the current directory press <Esc> to return to the edit box.
  45.                               Page 1 of 1
  46.           AVALIBLE HELP CONTEXTS HELP
  47.      Help Contexts are the set of help screens that will be available at a specific point in a program that is using the help library.  A help context can consist of a single help screen, or it can be a sequence with multiple pages of help screens.
  48.                                   Page 1 of 2
  49.                      AVAILABLE HELP CONTEXTS HELP
  50.      The following keys can be used to edit the current help contexts:
  51. INSERT -  Allows you to define additional help contexts.
  52. DELETE -  Deletes the currently highlighted help context, or if
  53.           multiple help contexts have been marked with the MARK key,
  54.           deletes all marked help contexts.
  55. SELECT -  Edit the text on the help screens associated with the
  56.           currently highlighted help context.
  57. ESCAPE -  Quits editing help library and asks if changes should be
  58.           saved.
  59. MODIFY -  Change the name of the currently highlighted help context.
  60. MARK   -  Toggles marking on the highlighted help context.
  61. CANCEL -  Unmarks all help context names that have been marked with
  62.           the MARK key.
  63.                                                          Page 2 of 2
  64.               HELP CONTEXT NAME HELP
  65.      Type in the name of the new help context that you want to add.  The name you enter will be used in the program's source code to reference the help screen(s) you create for this help context.
  66.                                     Page 1 of 1
  67.                    DELETE CONTEXT HELP
  68.      To delete the highlighted help context, answer YES.  If you do not want to delete the help context answer NO or press <Esc>.
  69.      If you have marked several help contexts with <F5> they will all be deleted if you answer YES.
  70.                                             Page 1 of 1
  71.                    END OF SEQUENCE HELP
  72.      This screen marks the end of the help context screen sequence.  This screen is simply a place holder so that a new screen can be inserted at the end of the help screen sequence.  To insert a new help screen press <Ins>.
  73.      If there are help screens defined for the current help context you can move to them by pressing <PgUp>.
  74.                                             Page 1 of 1
  75.                         HELP SCREEN SEQUENCE HELP
  76.      You can use the following keys to modify the current help context screen sequence:
  77. <Esc>         -  Return to the list of available help contexts.
  78. <Ins>         -  Add a new help screen in front of the screen you are
  79.                  currently viewing.
  80. <Del>         -  Delete the current help screen.
  81. <Enter>       -  Edit the text on the current help screen.
  82. <Left-Arrow>  -  Make width of current screen narrower.
  83. <Right-Arrow> -  Make width of current screen wider.
  84. <Up-Arrow>    -  Make height of current screen taller.
  85. <Down-Arrow>  -  Make height of current screen shorter.
  86. <PgUp>        -  Move to the previous help screen in the current help
  87.                  context screen sequence.
  88. <PgDn>        -   Move to the next help screen in the current help
  89.                   context screen sequence.
  90.                                                               Page 1 of 1
  91.                           EDIT SCREEN HELP
  92.      You can use the following keys to edit the text on the current help screen:
  93. <Esc>   - Exit the current screen and ask if changes you have made
  94.           should be saved.
  95. <F7>    - Cancel any changes to the current help screen.
  96. <Ins>   - Insert the text in the paste buffer at the current cursor
  97.           position.
  98. <Del>   - If text is marked with <F5>, pressing <Del> will cause
  99.           the marked text to be deleted and placed in the paste buffer.
  100. <Enter> - Insert a carriage return at the current cursor location and
  101.           advance cursor to next line.
  102. <F5>    - Toggle marking of text.  When marking is on the currently
  103.           selected text will be shown in reverse video.
  104.                                                         Page 1 of 1
  105.                THROW AWAY CHANGES HELP
  106.      If you do not want to save the changes you have made to the current help library then answer YES.  Otherwise answer NO or press <Esc>.
  107.                                         Page 1 of 1
  108.                           SAVE NAME HELP
  109.      Enter the name of the help library file where you want to save the help contexts.  Normally this name will be the same as the program name that will be using the help.  Press <Enter> when you have entered the name.
  110.      The help library name should be 8 characters or less.  If you want the help library to be saved in a directory other than the current directory, you must specify the directory path.
  111.      If you want to see a list of all the help library files in the current directory then press <Ins>.
  112.                                                     Page 1 of 1
  113.                CONFIRM OVERWRITE HELP
  114.      A help library with the name you specified already exists.  If you want to replace it with the help library you have just finished editing, position the highlight on YES and press <Enter>.  If you do not want to replace the old help library position the highlight on NO and press <Enter> or press <Esc>.
  115.                                        Page 1 of 1
  116.                 DELETE SCREEN HELP
  117.      If you want to delete the help screen you are currently viewing then answer YES.  If you do not want to delete the current help screen then answer NO or press <Esc>.
  118.                                       Page 1 of 1
  119.                  SAVE HELP LIBRARY HELP
  120.      If you want to save the changes you have made to the current help library then answer YES, otherwise answer NO.  If you answer no you will be asked if you really want to throw away the changes you have made.
  121.      If you want to resume editing the help library press <Esc>.
  122.                                           Page 1 of 1
  123.        TEXT TOO LARGE FOR HELP SCREEN HELP
  124.      The current help screen is too small for the text that you have entered.  You must resize the help screen so that it is larger (using <Up-Arrow> and <Right-Arrow>) or remove part of the text on the current help screen.
  125.      This message will continue to reappear until the text fits in the help screen.
  126.                                    Page 1 of 1
  127.             SCREEN IS MAXIMUM HEIGHT HELP
  128.      The current help screen has reached the maximum allowed height.  You can not make the screen any taller.
  129.      If you intend to use the help screen with an application that has a 4 line header (rather than the 3 line header that the help librarian uses) then you should keep all help screens at least one line shorter than the maximum allowed height.
  130.                                          Page 1 of 1
  131.          SCREEN IS MINIMUM HEIGHT HELP
  132.      The current help screen has reached the minimum allowed height.  You can not make the help screen less than 1 line tall.
  133.                                   Page 1 of 1
  134.           SCREEN IS MAXIMUM WIDTH HELP
  135.      The current help screen has reached the maximum allowed width.  You can not make the screen any wider.
  136.                                  Page 1 of 1
  137.           SCREEN IS MINIMUM WIDTH HELP
  138.      The current help screen has reached the minimum allowed width.  You can not make the help screen less than 1 character wide.
  139.                                  Page 1 of 1
  140.            ON FIRST HELP SCREEN HELP
  141.      You are on the first screen of the currently selected help context.  You can not use <PgUp> to move to a previous screen at this point.  If you want to create a help screen in front of the current screen then press <Ins>.
  142.                                     Page 1 of 1
  143.             ON LAST HELP SCREEN HELP
  144.      You are on the last help screen of the current help context.  You can not use <PgDn> to move to the next help screen.  If you want to put a new help screen at the end of the current help context screen sequence then press <Ins>.
  145.                                   Page 1 of 1
  146.                LIBRARY NAME HELP
  147.      The help library name can not be longer than 8 characters.  This is the maximum length allowed for file names by DOS (not counting the file extension).
  148.                                   Page 1 of 1
  149.                LIBRARY NAME HELP
  150.      The specified help library could not be found.  If the help library is not in the current directory, you must specify the path to reach the help library.
  151.                                  Page 1 of 1
  152.         HELP CONTEXT ALREADY EXISTS HELP
  153.      The context name you specified already exists.  If you want to edit the existing help context highlight the context name on the list of Available Help Contexts and press <Enter>.
  154.      If you want to add a new help context you must select a different name, or rename the existing help context.
  155.                                     Page 1 of 1
  156.             EXIT HELP LIBRARIAN HELP
  157.      If you have finished viewing the help screen in this help library, and do not want to save the changes that you have made, then answer YES.  If you do not want to exit then answer NO or press <Esc>.
  158. WARNING:
  159.      If you answer YES the changes you have made to the current help library will be lost.
  160.                                   Page 1 of 1
  161.         SAVE CHANGES TO HELP SCREEN HELP
  162.      If you want the changes you have made on the current help screen to be saved then answer YES.  If you do not want to save the changes then answer NO.  If you want to resume editing the text on the current help screen then press <Esc>.
  163.                                   Page 1 of 1
  164.        CANCEL CHANGES TO HELP SCREEN HELP
  165.      If you want to cancel all the changes you have made since you last began editing the text on the current help screen, then answer YES.  Otherwise, answer NO or press <Esc>.
  166.      If you answer YES the help screen text will be restored to its original state.
  167.                                   Page 1 of 1
  168.                 MARK IS ON HELP
  169.      You have attempted to insert text on the help screen while marking is turned on.  You must turn marking off (by pressing <F5> a second time) before you can insert more text on the help screen.
  170.                                   Page 1 of 1
  171.                 PASTE BUFFER EMPTY HELP
  172.      You pressed <Ins> which normally causes the text in the paste buffer to be inserted at the current cursor location.  There is no text in the paste buffer at the present time.
  173.      If you want to cut a block of text and insert it at a new location, you must first mark and delete the text using <F5> and <Del>.
  174.                                        Page 1 of 1
  175.                TEXT BUFFER FULL HELP
  176.      You have entered more text than will fit on the current help screen.  You must either delete some of the text or make the help screen larger.
  177.      To make the help screen larger you must press <Esc> to quit editing the text and after saving your changes, use <Up-Arrow> and <Right-Arrow> to make the screen larger.
  178.                                       Page 1 of 1
  179.         BLOCK MARKED TOO BIG FOR MEMORY HELP
  180.      When you mark a block of text and press <Del>, the text is deleted from the help screen and placed in a paste buffer.  Your machine does not have enough memory left to create a paste buffer big enough to hold the text you have marked.
  181.      You must delete the text in smaller blocks.
  182.                                         Page 1 of 1
  183.                NO CHARACTERS MARKED HELP
  184.      You pressed <Del> while marking was enabled, but no characters were marked.
  185.      If you want to mark and delete a section of text move the cursor so that the section of text you want to delete is marked in reverse video, then press <Del>.
  186.      If you do not want to delete a whole section of text then turn marking off by pressing <F5> a second time.
  187.                                          Page 1 of 1
  188.               HELP LIBRARY TYPE
  189. Position the highlight on PROGRAM and select it to create a help file that is unique to a particular program.
  190. Position the highlight on SYSTEM and select it to create a help file that is used by all programs.
  191.                                  Page 1 of 1
  192.        CAN'T FIND COMMAND.COM HELP
  193.      In order to exit to DOS, the file COMMAND.COM must be found in the DOS environment path.
  194.                           Page 1 of 1
  195.          CAN'T READ HELP LIBRARY HELP
  196. The help library you specified was found, but was unreadable by this program.  If you requested a system help file, you must run the C-Worthy Help Librarian without arguments.
  197.                                    Page 1 of 1
  198.             OUTPUT FILE NAME HELP
  199. Enter the name of the file that you would like your help screen text written to, then press <Enter>.
  200.                                    Page 1 of 1
  201.